package cn.iocoder.yudao.module.eval.service.announcement;

import cn.iocoder.yudao.framework.common.pojo.PageResult;
import cn.iocoder.yudao.module.eval.controller.admin.announcement.vo.*;
import cn.iocoder.yudao.module.eval.dal.dataobject.announcement.EvalAnnouncementDO;

import javax.validation.Valid;
import java.util.List;

/**
 * 公告发布 Service 接口
 *
 * @author 芋道源码
 */
public interface EvalAnnouncementService {

    /**
     * 创建公告发布
     *
     * @param createReqVO 创建信息
     * @return 编号
     */
    Long createAnnouncement(@Valid EvalAnnouncementSaveReqVO createReqVO);

    /**
     * 更新公告发布
     *
     * @param updateReqVO 更新信息
     */
    void updateAnnouncement(@Valid EvalAnnouncementSaveReqVO updateReqVO);

    /**
     * 删除公告发布
     *
     * @param id 编号
     */
    void deleteAnnouncement(Long id);

    /**
     * 获得公告发布
     *
     * @param id 编号
     * @return 公告发布
     */
    EvalAnnouncementDO getAnnouncement(Long id);

    /**
     * 获得公告发布分页
     *
     * @param pageReqVO 分页查询
     * @return 公告发布分页
     */
    PageResult<EvalAnnouncementDO> getAnnouncementPage(EvalAnnouncementPageReqVO pageReqVO);

    /**
     * 获得公告发布列表, 用于 Excel 导出
     *
     * @param exportReqVO 查询条件
     * @return 公告发布列表
     */
    List<EvalAnnouncementDO> getAnnouncementList(EvalAnnouncementPageReqVO exportReqVO);

    /**
     * 发布公告
     *
     * @param id 公告ID
     */
    void publishAnnouncement(Long id);

    /**
     * 撤回公告
     *
     * @param id 公告ID
     */
    void withdrawAnnouncement(Long id);

    /**
     * 置顶公告
     *
     * @param id 公告ID
     * @param topOrder 置顶顺序
     */
    void topAnnouncement(Long id, Integer topOrder);

    /**
     * 取消置顶
     *
     * @param id 公告ID
     */
    void cancelTopAnnouncement(Long id);

    /**
     * 根据计划ID获取公告列表
     *
     * @param planId 计划ID
     * @return 公告列表
     */
    List<EvalAnnouncementDO> getAnnouncementListByPlanId(Long planId);

    /**
     * 生成计划公告
     *
     * @param planId 计划ID
     * @param generateReqVO 生成信息
     * @return 公告ID
     */
    Long generatePlanAnnouncement(Long planId, @Valid EvalAnnouncementGenerateReqVO generateReqVO);

    /**
     * 生成成绩公告
     *
     * @param planId 计划ID
     * @param generateReqVO 生成信息
     * @return 公告ID
     */
    Long generateScoreAnnouncement(Long planId, @Valid EvalScoreAnnouncementGenerateReqVO generateReqVO);

    /**
     * 获取计划公告
     *
     * @param planId 计划ID
     * @param announcementType 公告类型
     * @param status 状态
     * @return 公告列表
     */
    List<EvalAnnouncementRespVO> getPlanAnnouncements(Long planId, String announcementType, Integer status);

    /**
     * 获取公开公告分页
     *
     * @param announcementType 公告类型
     * @param keyword 关键词
     * @param pageReqVO 分页查询
     * @return 公告分页
     */
    PageResult<EvalAnnouncementRespVO> getPublicAnnouncements(String announcementType, String keyword, @Valid EvalAnnouncementPageReqVO pageReqVO);

    /**
     * 获取公开公告详情
     *
     * @param id 公告ID
     * @return 公告详情
     */
    EvalAnnouncementRespVO getPublicAnnouncement(Long id);

    /**
     * 记录公告查看
     *
     * @param id 公告ID
     */
    void recordAnnouncementView(Long id);

    /**
     * 获取公告统计
     *
     * @param planId 计划ID
     * @return 统计信息
     */
    EvalAnnouncementStatisticsRespVO getAnnouncementStatistics(Long planId);

    /**
     * 发送公告通知
     *
     * @param id 公告ID
     * @param notificationReqVO 通知信息
     */
    void sendAnnouncementNotification(Long id, @Valid EvalAnnouncementNotificationReqVO notificationReqVO);

}
